<html>
<head>
<style type='text/css'>
body {
   background-color: white;
   margin: 1em 2em 1em 2em;
   font-family: Sans-Serif;
   color: #002;
   line-height: 140%;
   font-size: 12px;
}

h4 {
    font-size: 100%;
    font-style: normal;
    font-weight: bold;
}

h5 {
    font-size: 100%;
    font-style: italic;
    font-weight: normal;
}

pre {
   background-color: #eee;
   padding: 0.5em 0.5em 0.5em 2em;
}

@media print {
   pre {word-wrap:break-word; width:100%;}
} 

ul li,
ol li {
   padding-left: 0.3em;
   /*text-indent: -2em;*/
   margin-bottom: 0.5em;
}

em {
   font-style: normal;
   font-weight: bold;
   text-decoration: underline;
   color: #c40;
}

code {
   font-family: Monospace;
   font-size: 100%;
   color: #c40;
}

a, a * {
   text-decoration: underline;
   color: blue;
   /* border: 0.5px solid #aaa;
   white-space: nowrap;
   padding-right: 0.1em;
   padding-left: 0.1em;
   padding-bottom: -5px; */
}

a code {
   color: blue;
}

img {
   position: relative;
   bottom: -4px;
}

div.headline {
   font-weight: bold;
   font-size: 110%;
}

div.copyright {
   margin-top: 1em;
   border-top: 1px solid black;
   padding-top: 0.5em;
}

div.iris_headline {
   border-bottom: 1px solid black;
   padding-bottom: 0.3em;
}

.LaTeX {
   font-family: Monospace;
   font-size: 100%;
   border: 1px solid #060;
   color: #060;
}

code.LaTeX {
   background-color: white;
   padding: 0.5em 0.5em 0.5em 2em;
}
</style>
</head>

<body>
<div class="iris_headline">IRIS Toolbox Reference Manual</div>




<h2 id="poster/stats">stats</h2>
<div class="headline">Evaluate selected statistics of ARWM chain</div>

<h4 id="syntax">Syntax</h4>
<pre><code>S = stats(Pos,Theta,...)
S = stats(Pos,Theta,LogPost,...)
S = stats(Pos,FName,...)</code></pre>
<h4 id="input-arguments">Input arguments</h4>
<ul>
<li><p><code>Pos</code> [ poster ] - Posterior simulator object that has generated the <code>Theta</code> chain.</p></li>
<li><p><code>Theta</code> [ numeric ] - MCMC chain generated by the <a href="../poster/arwm.html"><code>poster/arwm</code></a> function.</p></li>
<li><p><code>LogPost</code> [ numeric ] - Vector of log posterior densities generated by the <code>arwm</code> function; <code>LogPost</code> is not necessary if you do not request <code>'mdd'</code>, the marginal data density.</p></li>
<li><p><code>FName</code> [ char ] - File name under which the simulated chain was saved when <a href="../poster/arwm.html"><code>poster/arwm</code></a> was run with options <code>saveEvery=</code>' and <code>'saveAs='</code>.</p></li>
</ul>
<h4 id="output-arguments">Output arguments</h4>
<ul>
<li><code>S</code> [ struct ] - Struct with the statistics requested by the user.</li>
</ul>
<h4 id="options">Options</h4>
<ul>
<li><p><code>'estTime='</code> [ <code>true</code> | <em><code>false</code></em> ] - Display and update the estimated time to go in the command window.</p></li>
<li><p><code>'mddGrid='</code> [ numeric | <em><code>0.1:0.1:0.9</code></em> ] - Points between 0 and 1 over which the marginal data density estimates will be averaged, see Geweke (1999).</p></li>
<li><p><code>'progress='</code> [ <code>true</code> | <em><code>false</code></em> ] - Display progress bar in the command window.</p></li>
</ul>
<h4 id="options-to-includeexclude-output-statistics">Options to include/exclude output statistics</h4>
<ul>
<li><p><code>'bounds='</code> [ <code>true</code> | <em><code>false</code></em> ] - Include in <code>S</code> the lower and upper parameter bounds set up by the user.</p></li>
<li><p><code>'chain='</code> [ <em><code>true</code></em> | <code>false</code> ] - Include in <code>S</code> the entire simulated chains of parameter values.</p></li>
<li><p><code>'cov='</code> [ <code>true</code> | <em><code>false</code></em> ] - Include in <code>S</code> the sample covariance matrix.</p></li>
<li><p>'<code>hist=</code>' [ numeric | <em>empty</em> ] - Include in <code>S</code> histogram bins and counts with the specified number of bins.</p></li>
<li><p><code>'hpdi='</code> [ <em><code>false</code></em> | numeric ] - Include in <code>S</code> the highest probability density intervals with the specified coverage.</p></li>
<li><p><code>'ksdensity='</code> [ <code>true</code> | <em><code>false</code></em> | numeric ] - Include in <code>S</code> the x- and y-axis points for kernel-smoothed posterior density; use a numeric value to control the number of points over which the density is computed.</p></li>
<li><p><code>'mdd='</code> [ <em><code>true</code></em> | <code>false</code> ] - Include in <code>S</code> minus the log marginal data density.</p></li>
<li><p><code>'mean='</code> [ <em><code>true</code></em> | <code>false</code> ] - Include in <code>S</code> the sample averages.</p></li>
<li><p><code>'median='</code> [ <code>true</code> | <em><code>false</code></em> ] - Include in <code>S</code> the sample medians.</p></li>
<li><p><code>'mode='</code> [ <code>true</code> | <em><code>false</code></em> ] - Include in <code>S</code> the sample modes based on histograms.</p></li>
<li><p><code>'prctile='</code> [ numeric | <em>empty</em> ] - Include in <code>S</code> the specified percentiles.</p></li>
<li><p><code>'std='</code> [ <em><code>true</code></em> | <code>false</code> ] - Include in <code>S</code> the sample std deviations.</p></li>
</ul>
<h4 id="description">Description</h4>
<h4 id="example">Example</h4>

</body>
<div class="copyright">IRIS Toolbox. Copyright &copy; 2007&#8212;2013 Jaromir Benes.</div>
</html>
